Skip to content

Conversation

johnny603
Copy link

@johnny603 johnny603 commented Oct 6, 2025

Description

prevent duplicate enum keys for timezone values with +/- signs

Fixes issue where enum values like "Etc/GMT+12" and "Etc/GMT-12"
generated identical TypeScript enum keys, causing TS1117 compilation errors.

Changes:

  • Replace '+' with 'Plus' and '-' with 'Minus' in enum variable names
  • Apply transformation before sanitization to ensure consistent processing
  • Add comprehensive test coverage for timezone enum collision scenarios

Resolves: #22074

Before: "Etc/GMT+12" and "Etc/GMT-12" both → "EtcGmt122" (collision)
After: "Etc/GMT+12" → "EtcGmtPlus12", "Etc/GMT-12" → "EtcGmtMinus12"

Mentions

@TiFu
@taxpon
@sebastianhaas
@kenisteward
@Vrolijkx
@macjohnny
@topce
@akehir
@petejohansonxo
@amakhrov
@davidgamero
@mkusaka
@joscha

PR checklist

  • Read the contribution guidelines.

  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.

  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java
    .
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.

  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)

  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes Update swagger-parser to 2.0.1 #123" present in the PR description)

  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

… +/- signs

Fixes issue where enum values like Etc/GMT+12 and Etc/GMT-12
generated identical TypeScript enum keys, causing TS1117 compilation errors.

Changes:
- Replace '+' with 'Plus' and '-' with 'Minus' in enum variable names
- Apply transformation before sanitization to ensure consistent processing
- Add comprehensive test coverage for timezone enum collision scenarios

Resolves: OpenAPITools#22074

Before: Etc/GMT+12 and Etc/GMT-12 both → EtcGmt122 (collision)
After:  Etc/GMT+12 → EtcGmtPlus12, Etc/GMT-12 → EtcGmtMinus12
@macjohnny
Copy link
Member

wouldn't this already work with the current release by simply setting the

public static final String ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR = "enumPropertyNamingReplaceSpecialChar";
option?

then this code block is executed:

if (isEnumPropertyNamingReplaceSpecialChar()) {
varName = varName.replaceAll("-", "_minus_");
varName = varName.replaceAll("\\+", "_plus_");
varName = varName.replaceAll("_+", "_");
}

also, the current proposal is not backwards compatible, so i would propose to avoid that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG][TYPESCRIPT] Duplicate enum keys cause TS1117 error
2 participants